GET api/bfg/v1/funds/cash-accounts?clientIds[0]={clientIds[0]}&clientIds[1]={clientIds[1]}

Gets cash-related accounts for multiple Paris clients in one call. Each row includes <see cref="P:TPP.B2B.Webservices2.Contracts2.BFG.Funds.CashAccounts.ClientId" /> for upstream grouping.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientIds

Repeated query parameter — one or more Paris client identifiers.

Collection of integer

Required

Body Parameters

None.

Response Information

Resource Description

A flat <see cref="T:TPP.B2B.Webservices2.Contracts2.BFG.Funds.CashAccountsResult" /> list keyed by <see cref="P:TPP.B2B.Webservices2.Contracts2.BFG.Funds.CashAccounts.ClientId" />.

CashAccountsResult
NameDescriptionTypeAdditional information
CashAccounts

Collection of CashAccounts

None.

Success

boolean

None.

Errors

Collection of string

None.

Response Formats

application/json, text/json

Sample:
{
  "CashAccounts": [
    {
      "ClientId": 1,
      "CashAccountType": "sample string 2",
      "AccountName": "sample string 3",
      "BankCode": "sample string 4",
      "BSB": "sample string 5",
      "AccountNumber": "sample string 6",
      "Balance": 1.0,
      "IsDefaultBuy": true,
      "IsDefaultSell": true,
      "IsDefaultDividend": true
    },
    {
      "ClientId": 1,
      "CashAccountType": "sample string 2",
      "AccountName": "sample string 3",
      "BankCode": "sample string 4",
      "BSB": "sample string 5",
      "AccountNumber": "sample string 6",
      "Balance": 1.0,
      "IsDefaultBuy": true,
      "IsDefaultSell": true,
      "IsDefaultDividend": true
    }
  ],
  "Success": true,
  "Errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<CashAccountsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Funds">
  <CashAccounts>
    <CashAccounts>
      <AccountName>sample string 3</AccountName>
      <AccountNumber>sample string 6</AccountNumber>
      <BSB>sample string 5</BSB>
      <Balance>1</Balance>
      <BankCode>sample string 4</BankCode>
      <CashAccountType>sample string 2</CashAccountType>
      <ClientId>1</ClientId>
      <IsDefaultBuy>true</IsDefaultBuy>
      <IsDefaultDividend>true</IsDefaultDividend>
      <IsDefaultSell>true</IsDefaultSell>
    </CashAccounts>
    <CashAccounts>
      <AccountName>sample string 3</AccountName>
      <AccountNumber>sample string 6</AccountNumber>
      <BSB>sample string 5</BSB>
      <Balance>1</Balance>
      <BankCode>sample string 4</BankCode>
      <CashAccountType>sample string 2</CashAccountType>
      <ClientId>1</ClientId>
      <IsDefaultBuy>true</IsDefaultBuy>
      <IsDefaultDividend>true</IsDefaultDividend>
      <IsDefaultSell>true</IsDefaultSell>
    </CashAccounts>
  </CashAccounts>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Errors>
  <Success>true</Success>
</CashAccountsResult>